docs: Add getting started guide, udpate pull request conventions #294
Conversation
| @@ -0,0 +1,59 @@ | |||
| --- | |||
| title: Pull Request Conventions | |||
There was a problem hiding this comment.
Is there any convention to request review/response/merge, like in slack, or we will rely only on github?
There was a problem hiding this comment.
I've messaged the GitHub team to see if we can combine our open-source and closed-source queues, but I think we will have to rely on GitHub to some extent for open source contributions from anyone external to Uber.
I also think we should decide on some conventions/tools around assigning PRs using Github, and we can add that to this document when we have those conventions figured out.
(My proposal is that we:
- use GitHub 'assign reviewer(s)' for all PRs that we know there is an appropriate reviewer (you can assign more than 1)
- use GitHub auto-assignment for all other PRs
But I don't have buy in for that yet)
| - For general Q&A, support/help, and announcements see [GitHub Discussions](https://github.com/cadence-workflow/cadence/discussions) | ||
| - To report bugs or request new features use [GitHub Issues](https://github.com/cadence-workflow/cadence/issues) | ||
| - For specific code questions/bugs use [Stack Overflow](https://stackoverflow.com/questions/tagged/cadence-workflow) |
There was a problem hiding this comment.
Taken from the Cadence README
| - [Make sync activity retry multiple times before fetch history from remote](https://github.com/cadence-workflow/cadence/pull/1379) | ||
| - [Enable archival config per domain](https://github.com/cadence-workflow/cadence/pull/1351) | ||
|
|
||
| ## Signing Commits |
There was a problem hiding this comment.
This is the only addition, the rest was moved from 'coding conventions'
| [Cadence docs](https://cadenceworkflow.io) is built using [Docusaurus](https://docusaurus.io/). | ||
|
|
||
|
|
||
| > 📚 **New to contributing to Cadence?** Check out our [Contributing Guide](https://cadenceworkflow.io/community/how-to-contribute/getting-started) for an overview of the contribution process across all Cadence repositories. This document contains cadence backend specific setup and development instructions. |
There was a problem hiding this comment.
Example of what we can add to other repos to get people started.
| @@ -0,0 +1,59 @@ | |||
| --- | |||
| title: Pull Request Conventions | |||
There was a problem hiding this comment.
I've messaged the GitHub team to see if we can combine our open-source and closed-source queues, but I think we will have to rely on GitHub to some extent for open source contributions from anyone external to Uber.
I also think we should decide on some conventions/tools around assigning PRs using Github, and we can add that to this document when we have those conventions figured out.
(My proposal is that we:
- use GitHub 'assign reviewer(s)' for all PRs that we know there is an appropriate reviewer (you can assign more than 1)
- use GitHub auto-assignment for all other PRs
But I don't have buy in for that yet)
2 participants
No description provided.